Details

Generate source maps files that can be used together with stack traces from Firebase Crashlytics
and show original code point of failure

Ideally source maps should be generated as part of the build process and then saved
Running npm run source-map:(ios|android) produces index.(ios|android).bundle.map file

• when Firebase Crashlytics captures an error
• we retrieve the source map for the errored platform & app version
• then decode the bundled code to original source (npm run symbolicate:(ios|android))

Alternatively source maps can be generated by checking older source in a separate work directory and running the source-map and symobilicate commands over it

Fixed Issues

$ #9293

Tests

Requirements to be able to test:

• Have JS stack traces (from Firebase Crashlytics)
• know the platform, app version of the stack trace
• find the commit which released the given app version
• check out a new branch from it and cherry pick the changes from this merge request
  • this is so we can (re)generate the same source and create source maps from it

Test Steps

• Generate source maps for the given platform (ios|android) should work

  • use npm run source-map:ios or npm run source-map:android
  • the following source map files should be generated if you run both commands:
    • index.ios.bundle.packager.map
    • index.android.bundle.packager.map
    • index.ios.bundle.hbc.map
    • index.android.bundle.hbc.map
    • index.ios.bundle.map
    • index.android.bundle.map

• Use the generated source maps to symbolicate (decode) the stack traces

  • stacktraces are expected to come from stdin, for testing purposes you can do the following:
    • save stacktraces to a file e.g. ios.stacktrace.txt
    • feed that file to the symbolicate command

    npm run symbolicate:ios < ios.stacktrace.txt > ios.decoded.stacktrace.txt

• Verify that no errors appear in the JS console

PR Review Checklist

Contributor (PR Author) Checklist

• I linked the correct issue in the ### Fixed Issues section above
• I wrote clear testing steps that cover the changes made in this PR
  • I added steps for local testing in the Tests section
  • I added steps for Staging and/or Production testing in the QA steps section
  • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
• I included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • iOS / native
  • Android / native
  • iOS / Safari
  • Android / Chrome
  • MacOS / Chrome
  • MacOS / Desktop
• I verified there are no console errors (if there’s a console error not related to the PR, report it or open an issue for it to be fixed)
• I followed proper code patterns (see Reviewing the code)
  • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
  • I verified that comments were added to code that is not self explanatory
  • I verified that any new or modified comments were clear, correct English, and explained “why” the code was doing something instead of only explaining “what” the code was doing.
  • I verified any copy / text shown in the product was added in all src/languages/* files
  • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team on the original GH to get the correct copy.
  • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named “index.js”. All platform-specific files are named for the platform the code supports as outlined in the README.
  • I verified the JSDocs style guidelines (in STYLE.md) were followed
• If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• I followed the guidelines as stated in the Review Guidelines
• I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
• I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
• If a new component is created I verified that:
  • A similar component doesn't exist in the codebase
  • All props are defined accurately and each prop has a /** comment above it */
  • Any functional components have the displayName property
  • The file is named correctly
  • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • The only data being stored in the state is data necessary for rendering and nothing else
  • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
  • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
  • All JSX used for rendering exists in the render method
  • The component has the minimum amount of code necessary for its purpose and it is
• If a new CSS style is added I verified that:
  • A similar style doesn’t already exist
  • The style can’t be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
• If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
• If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.

QA Steps

• Verify that no errors appear in the JS console

Screenshots

No App code changes, only tools added

Source mapping script running